Azure Blob Writer

Description

Azure Blob Writer is used to store Orchestra message data into a Microsoft blob storage.

Creation

To create an Azure Blob Writer follow the steps described in the general description of Channels.

Configuration

The dialog to configure the Azure Blob Writer looks like:

Base view of the channel Azure Blob Storage Writer

• In the Blobstore connection combo box, you must select an Azure Blob Storage Connection.

• If in the Blobstore connection the authentication method Client secret is selected, then you must select a User credential of type Technical login in the Access Key combo box. The credential must have a username/password authentication containing the access key id and the access key secret used to authenticate against the Azure blob storage. In the credential, the access key id is stored as username while the access key secret is stored as password. If the authentication method Shared key is selected you shall let the Access key empty (<no access key>).

• From the Operation combo box, you can select UPLOAD**, COPY or DELETE.

• In the Call timeout you can configure the amount of time that the Client will be given to complete the call.

Depending on the selected Operation and selected configuration options, the Channel will have different parameters.

UPLOAD

• This operation uploads the content of a message and stores it under the given blob name in the Azure container.

• If the option Container name as parameter is selected the container defined in the Azure Blob Storage Connection is not used. Instead, you must provide the container as value of the parameter CONTAINER_NAME.

If the operation UPLOAD is selected additional configuration options are available:

• If you select the checkbox Blobs are versioned, the UPLOAD operation will return the VERSION_ID of the stored blob. The DELETE and COPY operations will then require the VERSION_ID of the blob to delete or copy. Select this check box only if your container is configured to version the stored blobs!

• If you selected the checkbox Compare MD5 hash then the hash is computed and stored when uploading the blob. You may also provide the hash value as parameter, if you select the checkbox MD5 hash as parameter. If the value doesn't match the computed value an error occurs.

• If you have selected the checkbox add tags to blob then the channel will have an input parameter TAGS of type message. It must contain a Json message containing a Json object resembling the tags to be stored (a set of key / value pairs) along with the message.

Parameter name	Description
CONTAINER_NAME	If the option Container name as parameter is selected an additional input parameter CONTAINER_NAME is available. In this case you must provide the name of the container as parameter.
BLOB_NAME	The Identifier under which the message data will be stored in the blobstore container.
MSG	The message whose content is to be stored as a blob.
VERSION_ID	Output parameter: If the Blobs are versioned check box is selected, the version of the created blob is given as the value of this output parameter.
MD5Hash	If the MD5 hash as parameter check box is selected, you must provide the MD5 hash of the message content as the value of this parameter.
ETag	Output parameter: The unique ID of the created content.
TAGS	A Json message containing a Json object resembling the tags to be stored (a set of key / value pairs) along with the message. This parameter is available only if you have selected the checkbox add tags to blob.

COPY

This operation creates a copy of a blob stored in a container.

If the option Container name as parameter is selected the container defined in the Azure blobstore connection is not used. Instead, you must provide the name of the source container as value of the parameter SOURCE_CONTAINER and the name of the target container as value of the parameter TARGET_CONTAINER.

If you select the check box Blobs are versioned, the COPY operation can copy a specific version of the blob. Select this check box only if your container is configured to version the stored blobs!

Parameter name	Description
SOURCE_CONTAINER	If the Container name as parameter option is selected, you must provide the name of the source container as the value of this input parameter.
SOURCE_BLOB_NAME	The Identifier of the blob to copy.
TARGET_CONTAINER	If the Container name as parameter option is selected, you must provide the name of the destination container as the value of this input parameter.
TARGET_BLOB_NAME	The Identifier of the new blob to be created as a copy of the source.
VERSION_ID	If the option Blobs are versioned is selected, you can provide a specific version of the blob you want to copy. In this case, the version ID of the copy is also returned as the value of the output parameter VERSION_ID.

DELETE

This Operation deletes a blob on the azure blob storage.

If the option Container name as parameter is selected the container defined in the Azure blobstore connection is not used. Instead, you must provide the name of the container as value of the parameter CONTAINER_NAME.

If your container is configured to version the stored blobs, you can select the check box Blobs are versioned. You then also can provide a specific version id to delete a specific version of the blob.

Parameter name	Description
CONTAINER_NAME	If the option Container name as parameter is selected an additional input parameter CONTAINER_NAME is available. In this case you must provide the name of the container as value of this parameter.
BLOB_NAME	The Identifier of the blob you want to delete from the container.
VERSION_ID	If the option Blobs are versioned is selected, an additional optional input parameter VERSION_ID is available. If you specify this parameter, the specified version of the blob is deleted.